PUT Outstream Player Order

Overview

The following table contains important information about the PUT method in regards to updating the outstream player's order.

PUT Outstream Player by PublicId
Method	GET
URL or Endpoint	/api/v1/projects/`projectId`/outstream-players/order
Headers	Authorization
Parameters	projectId
Body	Check request body below

The description of the URL parameter is as follows:

Request Body

{
  "items": [
    {
      "id": "string",
      "orderNumber": 0
    }
  ]
}

Information about the fields that appear when you type in the request body are displayed in the table below.

Field Name	Type	Description
items	array[]	List of items included in the response.
id	string	Unique ID of the outstream player to be ordered.
orderNumber	integer	Order number of the outstream player.

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": true,
  "resultInfo": "string",
  "statusCode": 0
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	bool	Returns the result of the method.
resultInfo	string	Returns extra information about the result.
statusCode	integer	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

For information about the errors that are common to all actions, see Common Errors: